home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / src / Games / xephem-2.4b / README < prev    next >
Text File  |  1995-07-08  |  10KB  |  281 lines

  1. Welcome to xephem:
  2.  
  3. Xephem is an interactive astronomical ephemeris program for X Windows systems.
  4. It computes lots of information about the planets and any solar system objects
  5. for which orbital elements are available. A sample database of some 16000+
  6. objects is included in the release kit.  Xephem also displays information about
  7. the moons of Earth, Jupiter and Saturn; Mars' central meridian longitude; and a
  8. subsolar view of Earth. Xephem displays all information in user-configurable
  9. tabular menus as well as with schematic graphical displays. Xephem can also
  10. search for arbitrary circumstances among all objects, generate and display
  11. plots of all computed information and generate tabular listings of all
  12. information.
  13.  
  14. XEphem requires at least X11R4 and OSF/Motif 1.1 to build (see note below
  15. about a possible bug in X that has been reported). Very few Motif 1.1 features
  16. were used so a back-port to Motif 1.0 should be fairly easy; contact the author
  17. for assistance.
  18.  
  19. There is only a small manual, but there is extensive on-line help. So, the
  20. first thing to do is to build xephem - see next - then start selecting the Help
  21. buttons.
  22.  
  23. Building xephem:
  24.  
  25.     Building xephem is intended to be easy. Everything is in .c and .h files
  26.     in one directory. Just compile everything with the Motif include files and
  27.     link it with the X and Motif libraries as you would any Motif application;
  28.     and don't forget the math library, -lm. A DCL file to build xephem on
  29.     VMS/DECWindows MOTIF is included at the end of this file.
  30.     
  31.     If your system is set up for using xmkmf, then to build xephem just type:
  32.  
  33.     xmkmf
  34.     make
  35.  
  36.     If not, there is also a Makefile.simple.
  37.  
  38.     atof() can be somewhat problematic. It was historically declared to be
  39.     double in math.h. More contemporary systems declare it only in stdlib.h.
  40.     Xephem includes stdlib.h if __STDC__ is defined, else it assumes atof()
  41.     is declared in math.h.  This should work pretty well but if you get
  42.     crazy numbers from xephem check the files that use atof and figure out a
  43.     way to get it declared to return a double. Atof() is called in compiler.c,
  44.     db.c, formats.c, mainmenu.c and satmenu.c.
  45.  
  46.     Also, on some systems (such as SVR3.2) compile with -D_NO_PROTO and -DSYSV.
  47.  
  48.     I have searched carefully through the output of running all of xephem
  49.     through lint and gcc on Ultrix and SVR4 and can rationalize all the
  50.     warnings so don't let these bother you.
  51.  
  52. Running xephem:
  53.  
  54.     There are fallback resources included in the main program all set to work
  55.     on monochrome systems so don't worry about putting the resource file,
  56.     XEphem.ad, anywhere for now. Another way to run on a black and white
  57.     display is to use the command line arguments: "-fg white -bg black".
  58.  
  59.     Go ahead and start xephem by just typing it's name: `xephem'.
  60.  
  61.     The best way to learn xephem is to run it and read some of the Help
  62.     entries. A good order to read them is the way they are listed in the Help
  63.     pulldown off the main menu.  Soon, you will want to edit and install the
  64.     XEphem.ad resources file entries that contain location information and a
  65.     few other things. Read the default resource file, XEphem.ad, and follow the
  66.     notes in there.
  67.  
  68. Possible X compatibility problem:
  69.  
  70.     It has been reported that xephem's Sky View and Solar System menus do not
  71.     work using X11R4 twm with X11R4 X. The symptom is that when these views are
  72.     selected an X error occurs as follows:
  73.  
  74.     X Error of failed request:  BadAccess 
  75.     Major opcode of failed request:  28 (X_GrabButton)
  76.     Minor opcode of failed request:  0
  77.  
  78.     This does not occur using X11R5 twm with either X11R4 X or X11R5 X nor
  79.     does it occur running mwm with either X11R4 X or X11R5 X. Xephem is known
  80.     to run on the following configurations:
  81.  
  82.  
  83. xephem v2.4b is known to run on the following systems; check with the author
  84. for availability of statically linked binary executables.
  85.  
  86.     OS                      CPU                     X
  87.     -----------             ---------------         ---------------------------
  88.     SVR3.2/Venix            i486                    Metrolink X11R4/Motif 1.1.3
  89.     SVR4.0.3/Consensys      i486                    MIT X11R5/Motif 1.1.4
  90.     Ultrix 4.2              DECstation 5000         DEC's (?)
  91.     SunOS 4.1.2             Sun 4c                  TeleUSE development system
  92.     hpux 8.07               HP 9000/720             X11R4, Motif 1.1.?
  93.     IRIX 4.0.5              SGI                     X11R4
  94.     OSF/1 1.2               DEC Alpha               X11R5, Motif 1.1.3
  95.  
  96.  
  97. If you would like to gut xephem for just its astronomical functionality, start
  98. with obj_cir(). This is basically the dividing line between the user interface
  99. and the astronomical functions. Also, the following files are pretty much just
  100. pure transliterations from BASIC into C from machine-readable copies of the
  101. programs in Duffett-Smith's book.  They have nothing to do with the rest of
  102. ephem so they may be used for completely different applications if so desired.
  103.  
  104.     aa_hadec.c anomaly.c astro.h cal_mjd.c comet.c eq_ecl.c moon.c moonnf.c
  105.     nutation.c obliq.c parallax.c pelement.c plans.c reduce.c refract.c
  106.     sex_dec.c sun.c utc_gst.c
  107.  
  108. The sample database, ephem.db:
  109.  
  110.     This is a sample collection of astroids, stars and deep-sky objects to
  111.     get you started. References, when I had them, are included in the file.
  112.  
  113.     This database is compatible with ephem v4.28 EXCEPT that ephem requires
  114.     entries to start with an alpha character. Either add one to all such
  115.     entries in this db or modify the function nxt_db() to allow a leading digit
  116.     as well.
  117.     
  118.     Asteroids are given by their common name, if it has been assigned, followed
  119.     by their numeric sequence number. Those that do not yet have a common
  120.     name assigned are given by sequence number followed by year and designation
  121.     of discovery. The list goes to 4848.
  122.  
  123.     The stars are from the Yale Bright star catalogue. Only those entries with
  124.     at least a constellation name and either a common name or some sort of
  125.     designator are included. Bayer designations are given as the Greek letter
  126.     spelled out (I know -- I could have used Greek letters in X but that would
  127.     break compatability with ephem).
  128.  
  129.     The deep-sky entries are from the Saguaro Astronomy Club database Version
  130.     5.0. The Messier objects are entered twice; once by M number and once
  131.     by NGC number.
  132.  
  133.     Work on the database is a project in itself. Authoritative contributions
  134.     welcome.
  135.  
  136.     I have worked up several awk scripts to convert various files into ephem
  137.     format. Contact the author if you need one or have one.
  138.  
  139.     Finally, I have the entire SAO database from NSSDC broken down it into 10
  140.     files in ephem format. There are total of 258997 entries. The complete
  141.     set is 11332256 bytes, 3034691 compressed. I have put them on export
  142.     near xephem.
  143.  
  144. Let me know what you think about xephem, good or bad. Thank you.
  145.  
  146. Elwood Downey
  147. 419 36th Street NE
  148. Cedar Rapids, IA  52402
  149.  
  150. ecdowney@pobox.cca.cr.rockwell.com
  151.  
  152. April 21, 1993
  153.  
  154. The following (untested!) DCL file will build xephem for VMS/DECwindows MOTIF;
  155. based on an earlier version by Ethan VanMatre:
  156.  
  157. $!
  158. $!    Makefile.com -- Command file to compile and link Xephem
  159. $!
  160. $!
  161. $!    A simple minded command file to compile and link Xephem under VAX/VMS
  162. $!    and DECwindows MOTIF 
  163. $!
  164. $!    when        who            what
  165. $!
  166. $!    2-feb-1992    Ethan VanMatre        original from unix makefile
  167. $!
  168. $
  169. $ cc    aa_hadec/opt/obj
  170. $ cc    anomaly    /opt/obj
  171. $ cc    cal_mjd    /opt/obj
  172. $ cc    calmenu    /opt/obj
  173. $ cc    circum    /opt/obj
  174. $ cc    comet    /opt/obj
  175. $ cc    compiler/opt/obj
  176. $ cc    constel    /opt/obj
  177. $ cc    datamenu/opt/obj
  178. $ cc    db      /opt/obj
  179. $ cc    dbmenu  /opt/obj
  180. $ cc    earthmap/opt/obj
  181. $ cc    earthmenu/opt/obj
  182. $ cc    eq_ecl    /opt/obj
  183. $ cc    formats    /opt/obj
  184. $ cc    helpmenu/opt/obj
  185. $ cc    jupmenu    /opt/obj
  186. $ cc    listmenu/opt/obj
  187. $ cc    mainmenu/opt/obj
  188. $ cc    marsmenu/opt/obj
  189. $ cc    misc    /opt/obj
  190. $ cc    moon    /opt/obj
  191. $ cc    moonmenu/opt/obj
  192. $ cc    moonnf    /opt/obj
  193. $ cc    msgmenu /opt/obj
  194. $ cc    nutation/opt/obj
  195. $ cc    objmenu    /opt/obj
  196. $ cc    obliq    /opt/obj
  197. $ cc    parallax/opt/obj
  198. $ cc    pelement/opt/obj
  199. $ cc    plans    /opt/obj
  200. $ cc    plot_aux/opt/obj
  201. $ cc    plotmenu/opt/obj
  202. $ cc    precess    /opt/obj
  203. $ cc    query    /opt/obj
  204. $ cc    reduce    /opt/obj
  205. $ cc    refract    /opt/obj
  206. $ cc    riset    /opt/obj
  207. $ cc    riset_cir/opt/obj
  208. $ cc    risetmenu/opt/obj
  209. $ cc    satmenu    /opt/obj
  210. $ cc    sex_dec    /opt/obj
  211. $ cc    skyfiltmenu/opt/obj
  212. $ cc    skyviewmenu/opt/obj
  213. $ cc    solsysmenu/opt/obj
  214. $ cc    srchmenu/opt/obj
  215. $ cc    sun    /opt/obj
  216. $ cc    time    /opt/obj
  217. $ cc    utc_gst    /opt/obj
  218. $ cc    versionmenu/opt/obj
  219. $ cc    xephem    /opt/obj
  220. $!
  221. $ LINK    xephem.obj,    -
  222.     aa_hadec.obj,    -
  223.     anomaly.obj,    -
  224.     cal_mjd.obj,    -
  225.     calmenu.obj,    -
  226.     circum.obj,    -
  227.     comet.obj,    -
  228.     compiler.obj,    -
  229.     constel.obj,    -
  230.     datamenu.obj,    -
  231.     db.obj,    -
  232.     dbmenu.obj,    -
  233.     earthmap.obj,    -
  234.     earthmenu.obj,    -
  235.     eq_ecl.obj,    -
  236.     formats.obj,    -
  237.     helpmenu.obj,    -
  238.     jupmenu.obj,    -
  239.     listmenu.obj,    -
  240.     mainmenu.obj,    -
  241.     marsmenu.obj,    -
  242.     misc.obj,    -
  243.     moon.obj,    -
  244.     moonmenu.obj,    -
  245.     moonnf.obj,    -
  246.     msgmenu.obj,    -
  247.     nutation.obj,    -
  248.     objmenu.obj,    -
  249.     obliq.obj,    -
  250.     parallax.obj,    -
  251.     pelement.obj,    -
  252.     plans.obj,    -
  253.     plot_aux.obj,    -
  254.     plotmenu.obj,    -
  255.     precess.obj,    -
  256.     query.obj,    -
  257.     reduce.obj,    -
  258.     refract.obj,    -
  259.     riset.obj,    -
  260.     riset_cir.obj,    -
  261.     risetmenu.obj,    -
  262.     satmenu.obj,    -
  263.     sex_dec.obj,    -
  264.     skyfiltmenu.obj,    -
  265.     skyviewmenu.obj,    -
  266.     solsysmenu.obj,    -
  267.     srchmenu.obj,    -
  268.     sun.obj,    -
  269.     time.obj,    -
  270.     utc_gst.obj,    -
  271.     versionmenu.obj,    -
  272.     sys$input/opt
  273. sys$share:decw$dxmlibshr/share
  274. sys$share:decw$xmlibshr/share
  275. sys$share:decw$xlibshr/share
  276. sys$share:vaxcrtl/share
  277. $!
  278. $!clean:
  279. $    purge
  280. $!
  281.